Envelope Status Changes
AutomatR.DocuSign.Activities.EnvelopeStatusChanges
The "Envelope Status Changes" activity in AutomatR is part of the DocuSign activities package, allowing users to retrieve information about changes in envelope status within DocuSign. This activity is useful for tracking and managing the status of envelopes in automated workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| From Date | Enter the from date in the format 'YYYY-MM-DDTHH:MM:SSZ for UTC time or YYYY-MM-DDTHH:MM:SS±HH:MM'. String variables containing the from date. |
| Envelope IDs | Enter the envelope IDs as a comma-separated list of GUIDs. String variables containing the envelope IDs. |
| User Filter | Specifies the user filter for retrieving envelope status changes. Options include all, changes_only, or recipient_activity. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Envelope Status Changes" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Response | Returns the envelope status changes information with data type List<Envelope>. Variables of relevant types (e.g., List<Envelope>) to store the envelope status changes. |
How to use:
- Drag and drop the "Envelope Status Changes" activity onto the workflow.
- Configure the properties by providing the necessary input values, such as the delay, from date, envelope IDs, and user filter.
- Execute the workflow to retrieve information about changes in envelope status.
Important Note:
- Ensure that the "Envelope Status Changes" activity is used within the scope of the "DocuSign Scope" activity.
Example: Consider an example where the "Envelope Status Changes" activity is used to retrieve status changes for specific envelopes:
Envelope Status Changes:
Delay: 5
From Date: "2023-01-01T00:00:00Z"
Envelope IDs: "guid1, guid2, guid3"
User Filter: all
Response: envelopeStatusChanges
In this example, the activity retrieves envelope status changes for the specified envelope IDs from the given date. The obtained information is stored in the variable "envelopeStatusChanges" for further processing in the workflow.